Package | hl7.fhir.us.physical-activity |
Type | ExampleScenario |
Id | Id |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/physical-activity/https://build.fhir.org/ig/HL7/physical-activity/ExampleScenario-Scen3ProviderToYMCAReferral.html |
Url | http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen3ProviderToYMCAReferral |
Version | 1.0.1 |
Status | draft |
Date | 2024-03-12T17:26:10+00:00 |
Name | PatientSeeksReferralforExerciseProgram |
Experimental | False |
Realm | us |
Authority | hl7 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ExampleScenario
Resource ExampleScenario "Scen3ProviderToYMCAReferral"
wg: pc
url: http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen3ProviderToYMCAReferral
version: 1.0.1
name: PatientSeeksReferralforExerciseProgram
status: draft
date: 2024-03-12 17:26:10+0000
publisher: HL7 International / Patient Care
contact: HL7 International / Patient Care: http://www.hl7.org/Special/committees/patientcare
jurisdiction: United States of America (ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code#US)
actor
actorId: mainClinic
type: entity
name: Main Street Clinic
description: Dr. Blackrock's EHR - creates referral at patient's request
actor
actorId: YMCA
type: entity
name: Cincinnati Central YMCA
description: Fitness service provider who offers exercise program
instance
resourceId: Scen3query1
resourceType: Binary
name: Query for Referral & Patient for YMCA Task
description: Search to retrieve ServiceRequest and Patient for specified Task: `GET https://mainClinic.example.org/fhir/ServiceRequest?_id=Scen3ServiceRequest&_include=ServiceRequest:patient`
instance
resourceId: Scen3query2
resourceType: Binary
name: Query for EHR-issued task based on notification
description: Search to retrieve Task: `GET https://YMCA.example.org/fhir/Task?_id=Scen3TaskYMCA`
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Subscription/Scen3SubscriptionEhr
resourceId: Scen3SubscriptionEhr
resourceType: Subscription
name: Subscription from EHR
description: Establishes the subscription for the EHR to monitor tasks it's created
instance
resourceId: Scen3TaskYMCA
resourceType: Task
name: Task seeking FitLife to fulfill referral
description: A Task seeking fulfillment by the YMCA of the referral for an exercise program
version
Extension Definition for ExampleScenario.instance.version.title for Version 5.0: Initial YMCA Task
Extension Definition for ExampleScenario.instance.version.content for Version 5.0: Task/Scen3TaskYMCAV1
versionId: 1
description: Initial version of the referral fulfillment request for YMCA with a status of 'requested'
version
Extension Definition for ExampleScenario.instance.version.title for Version 5.0: Updated YMCA Task
Extension Definition for ExampleScenario.instance.version.content for Version 5.0: Task/Scen3TaskYMCAV2
versionId: 2
description: Version of the referral fulfillment request for YMCA after it has been changed to 'accepted'
version
Extension Definition for ExampleScenario.instance.version.title for Version 5.0: Completed YMCA Task
Extension Definition for ExampleScenario.instance.version.content for Version 5.0: Task/Scen3TaskYMCAV3
versionId: 3
description: Version of the referral fulfillment request for YMCA after it has been changed to 'completed' and a link to the report added
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen3ServiceRequestYMCAResponseBundle
resourceId: Scen3ServiceRequestYMCAResponseBundle
resourceType: Bundle
name: ServiceRequest search response for YMCA
description: Search-set Bundle returning ServiceRequest and Patient for the Task posted to the YMCA
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen3NotificationUpdatedTaskBundle
resourceId: Scen3NotificationUpdatedTaskBundle
resourceType: Bundle
name: Subscription Notification that Task has updated
description: Pointer to the Task that has been updated
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen3NotificationCompletedTaskBundle
resourceId: Scen3NotificationCompletedTaskBundle
resourceType: Bundle
name: Subscription Notification that Task has completed
description: Pointer to the Task that has been updated
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen3TaskEHRResponseBundle1
resourceId: Scen3TaskEHRResponseBundle1
resourceType: Bundle
name: Accepted Task search response for EHR
description: Search-set Bundle returning 'accepted' Task with id based on subscription notification
ContainedInstances
ResourceId VersionId Scen3TaskYMCA 2
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen3TaskEHRResponseBundle2
resourceId: Scen3TaskEHRResponseBundle2
resourceType: Bundle
name: Completed Task search response for EHR
description: Search-set Bundle returning 'completed' Task with id based on subscription notification
ContainedInstances
ResourceId VersionId Scen3TaskYMCA 3
process
title: Subscription Establishment
preConditions: Main Street Clinic and Cinicinnati Central YMCA have established legal and technical arrangements for interoperability
postConditions: Subscription is successfully created allowing Main Street Clinic to monitor YMCA-assigned Tasks
step
operation
number: 1
type: create
name: Create EHR-monitoring Subscription
initiator: YMCA
receiver: mainClinic
description: YMCA posts Subscription to EHR to monitor Tasks. Request: `POST https://mainClinic.example.org/fhir/Subscription` Response: `201 Created`
Requests
ResourceId Scen3SubscriptionEhr
process
title: A minute after creation of ServiceRequest
preConditions: EHR has created a ServiceRequest for Mr. Shevchenko
postConditions: YMCA has retrieved the ServiceRequest and the Patient, and updated the Task to 'in-progress'
step
operation
number: 2
type: create
name: Create Task on YMCA
initiator: mainClinic
receiver: YMCA
description: New Task is created directly on YMCA's server. Request: `POST https://YMCA.example.org/fhir/Task` Response: `201 Created`
Requests
ResourceId VersionId Scen3TaskYMCA 1 step
operation
number: 3
type: search-type
name: YMCA retrieves referral
initiator: YMCA
receiver: mainClinic
description: YMCA retrieves the ServiceRequest and Patient referenced by the Task.
Requests
ResourceId Scen3query1 Responses
ResourceId Scen3ServiceRequestYMCAResponseBundle step
operation
number: 4
type: create
name: EHR gets referral acceptance
initiator: YMCA
receiver: mainClinic
description: A subscription notification to the EHR is triggered when YMCA changes the prescription status to 'in-progress'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`
Requests
ResourceId Scen3NotificationUpdatedTaskBundle step
operation
number: 5
type: search-type
name: EHR retrieves in-progress Task
initiator: mainClinic
receiver: YMCA
description: EHR retrieves the Task referenced by the subscription notification
Requests
ResourceId Scen3query2 Responses
ResourceId Scen3TaskEHRResponseBundle1
process
title: About 4 Months Later
preConditions: YMCA is actively working on the Task
postConditions: YMCA has completed the referral and Dr. Blackrock is aware of the results
step
operation
number: 6
type: create
name: EHR gets referral acceptance
initiator: YMCA
receiver: mainClinic
description: A subscription notification to the EHR is triggered when the YMCA changes the Task status to 'completed'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`
Requests
ResourceId Scen3NotificationCompletedTaskBundle step
operation
number: 7
type: search-type
name: EHR retrieves completed Task
initiator: mainClinic
receiver: YMCA
description: EHR retrieves the Task referenced by the subscription notification
Requests
ResourceId Scen3query2 Responses
ResourceId Scen3TaskEHRResponseBundle2
{
"resourceType" : "ExampleScenario",
"id" : "Scen3ProviderToYMCAReferral",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: ExampleScenario</b><a name=\"Scen3ProviderToYMCAReferral\"> </a><a name=\"hcScen3ProviderToYMCAReferral\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource ExampleScenario "Scen3ProviderToYMCAReferral" </p></div><p><b>wg</b>: pc</p><p><b>url</b>: <code>http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen3ProviderToYMCAReferral</code></p><p><b>version</b>: 1.0.1</p><p><b>name</b>: PatientSeeksReferralforExerciseProgram</p><p><b>status</b>: draft</p><p><b>date</b>: 2024-03-12 17:26:10+0000</p><p><b>publisher</b>: HL7 International / Patient Care</p><p><b>contact</b>: HL7 International / Patient Care: <a href=\"http://www.hl7.org/Special/committees/patientcare\">http://www.hl7.org/Special/committees/patientcare</a></p><p><b>jurisdiction</b>: United States of America <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.0.0/CodeSystem-ISO3166Part1.html\">ISO 3166-1 Codes for the representation of names of countries and their subdivisions â Part 1: Country code</a>#US)</span></p><blockquote><p><b>actor</b></p><p><b>actorId</b>: mainClinic</p><p><b>type</b>: entity</p><p><b>name</b>: Main Street Clinic</p><p><b>description</b>: Dr. Blackrock's EHR - creates referral at patient's request</p></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: YMCA</p><p><b>type</b>: entity</p><p><b>name</b>: Cincinnati Central YMCA</p><p><b>description</b>: Fitness service provider who offers exercise program</p></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Scen3query1</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Query for Referral & Patient for YMCA Task</p><p><b>description</b>: Search to retrieve ServiceRequest and Patient for specified Task: `GET https://mainClinic.example.org/fhir/ServiceRequest?_id=Scen3ServiceRequest&_include=ServiceRequest:patient`</p></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Scen3query2</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Query for EHR-issued task based on notification</p><p><b>description</b>: Search to retrieve Task: `GET https://YMCA.example.org/fhir/Task?_id=Scen3TaskYMCA`</p></blockquote><blockquote><p><b>instance</b></p><p><b>Extension Definition for ExampleScenario.instance.content for Version 5.0</b>: <a href=\"Subscription-Scen3SubscriptionEhr.html\">Subscription/Scen3SubscriptionEhr</a></p><p><b>resourceId</b>: Scen3SubscriptionEhr</p><p><b>resourceType</b>: Subscription</p><p><b>name</b>: Subscription from EHR</p><p><b>description</b>: Establishes the subscription for the EHR to monitor tasks it's created</p></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Scen3TaskYMCA</p><p><b>resourceType</b>: Task</p><p><b>name</b>: Task seeking FitLife to fulfill referral</p><p><b>description</b>: A Task seeking fulfillment by the YMCA of the referral for an exercise program</p><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Initial YMCA Task</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Task-Scen3TaskYMCAV1.html\">Task/Scen3TaskYMCAV1</a></p><p><b>versionId</b>: 1</p><p><b>description</b>: Initial version of the referral fulfillment request for YMCA with a status of 'requested'</p></blockquote><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Updated YMCA Task</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Task-Scen3TaskYMCAV2.html\">Task/Scen3TaskYMCAV2</a></p><p><b>versionId</b>: 2</p><p><b>description</b>: Version of the referral fulfillment request for YMCA after it has been changed to 'accepted'</p></blockquote><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Completed YMCA Task</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Task-Scen3TaskYMCAV3.html\">Task/Scen3TaskYMCAV3</a></p><p><b>versionId</b>: 3</p><p><b>description</b>: Version of the referral fulfillment request for YMCA after it has been changed to 'completed' and a link to the report added</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>Extension Definition for ExampleScenario.instance.content for Version 5.0</b>: <a href=\"Bundle-Scen3ServiceRequestYMCAResponseBundle.html\">Bundle/Scen3ServiceRequestYMCAResponseBundle</a></p><p><b>resourceId</b>: Scen3ServiceRequestYMCAResponseBundle</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: ServiceRequest search response for YMCA</p><p><b>description</b>: Search-set Bundle returning ServiceRequest and Patient for the Task posted to the YMCA</p></blockquote><blockquote><p><b>instance</b></p><p><b>Extension Definition for ExampleScenario.instance.content for Version 5.0</b>: <a href=\"Bundle-Scen3NotificationUpdatedTaskBundle.html\">Bundle/Scen3NotificationUpdatedTaskBundle</a></p><p><b>resourceId</b>: Scen3NotificationUpdatedTaskBundle</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Subscription Notification that Task has updated</p><p><b>description</b>: Pointer to the Task that has been updated</p></blockquote><blockquote><p><b>instance</b></p><p><b>Extension Definition for ExampleScenario.instance.content for Version 5.0</b>: <a href=\"Bundle-Scen3NotificationCompletedTaskBundle.html\">Bundle/Scen3NotificationCompletedTaskBundle</a></p><p><b>resourceId</b>: Scen3NotificationCompletedTaskBundle</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Subscription Notification that Task has completed</p><p><b>description</b>: Pointer to the Task that has been updated</p></blockquote><blockquote><p><b>instance</b></p><p><b>Extension Definition for ExampleScenario.instance.content for Version 5.0</b>: <a href=\"Bundle-Scen3TaskEHRResponseBundle1.html\">Bundle/Scen3TaskEHRResponseBundle1</a></p><p><b>resourceId</b>: Scen3TaskEHRResponseBundle1</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Accepted Task search response for EHR</p><p><b>description</b>: Search-set Bundle returning 'accepted' Task with id based on subscription notification</p><h3>ContainedInstances</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td><td><b>VersionId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3TaskYMCA</td><td>2</td></tr></table></blockquote><blockquote><p><b>instance</b></p><p><b>Extension Definition for ExampleScenario.instance.content for Version 5.0</b>: <a href=\"Bundle-Scen3TaskEHRResponseBundle2.html\">Bundle/Scen3TaskEHRResponseBundle2</a></p><p><b>resourceId</b>: Scen3TaskEHRResponseBundle2</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Completed Task search response for EHR</p><p><b>description</b>: Search-set Bundle returning 'completed' Task with id based on subscription notification</p><h3>ContainedInstances</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td><td><b>VersionId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3TaskYMCA</td><td>3</td></tr></table></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Subscription Establishment</p><p><b>preConditions</b>: Main Street Clinic and Cinicinnati Central YMCA have established legal and technical arrangements for interoperability</p><p><b>postConditions</b>: Subscription is successfully created allowing Main Street Clinic to monitor YMCA-assigned Tasks</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: create</p><p><b>name</b>: Create EHR-monitoring Subscription</p><p><b>initiator</b>: YMCA</p><p><b>receiver</b>: mainClinic</p><p><b>description</b>: YMCA posts Subscription to EHR to monitor Tasks. Request: `POST https://mainClinic.example.org/fhir/Subscription` Response: `201 Created`</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3SubscriptionEhr</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: A minute after creation of ServiceRequest</p><p><b>preConditions</b>: EHR has created a ServiceRequest for Mr. Shevchenko</p><p><b>postConditions</b>: YMCA has retrieved the ServiceRequest and the Patient, and updated the Task to 'in-progress'</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 2</p><p><b>type</b>: create</p><p><b>name</b>: Create Task on YMCA</p><p><b>initiator</b>: mainClinic</p><p><b>receiver</b>: YMCA</p><p><b>description</b>: New Task is created directly on YMCA's server. Request: `POST https://YMCA.example.org/fhir/Task` Response: `201 Created`</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td><td><b>VersionId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3TaskYMCA</td><td>1</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 3</p><p><b>type</b>: search-type</p><p><b>name</b>: YMCA retrieves referral</p><p><b>initiator</b>: YMCA</p><p><b>receiver</b>: mainClinic</p><p><b>description</b>: YMCA retrieves the ServiceRequest and Patient referenced by the Task.</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3query1</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3ServiceRequestYMCAResponseBundle</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 4</p><p><b>type</b>: create</p><p><b>name</b>: EHR gets referral acceptance</p><p><b>initiator</b>: YMCA</p><p><b>receiver</b>: mainClinic</p><p><b>description</b>: A subscription notification to the EHR is triggered when YMCA changes the prescription status to 'in-progress'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3NotificationUpdatedTaskBundle</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 5</p><p><b>type</b>: search-type</p><p><b>name</b>: EHR retrieves in-progress Task</p><p><b>initiator</b>: mainClinic</p><p><b>receiver</b>: YMCA</p><p><b>description</b>: EHR retrieves the Task referenced by the subscription notification</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3query2</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3TaskEHRResponseBundle1</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: About 4 Months Later</p><p><b>preConditions</b>: YMCA is actively working on the Task</p><p><b>postConditions</b>: YMCA has completed the referral and Dr. Blackrock is aware of the results</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 6</p><p><b>type</b>: create</p><p><b>name</b>: EHR gets referral acceptance</p><p><b>initiator</b>: YMCA</p><p><b>receiver</b>: mainClinic</p><p><b>description</b>: A subscription notification to the EHR is triggered when the YMCA changes the Task status to 'completed'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3NotificationCompletedTaskBundle</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 7</p><p><b>type</b>: search-type</p><p><b>name</b>: EHR retrieves completed Task</p><p><b>initiator</b>: mainClinic</p><p><b>receiver</b>: YMCA</p><p><b>description</b>: EHR retrieves the Task referenced by the subscription notification</p><h3>Requests</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3query2</td></tr></table><h3>Responses</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ResourceId</b></td></tr><tr><td style=\"display: none\">*</td><td>Scen3TaskEHRResponseBundle2</td></tr></table></blockquote></blockquote></blockquote></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
}
],
"url" : "http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen3ProviderToYMCAReferral",
"version" : "1.0.1",
"name" : "PatientSeeksReferralforExerciseProgram",
"status" : "draft",
"date" : "2024-03-12T17:26:10+00:00",
"publisher" : "HL7 International / Patient Care",
"contact" : [
{
"name" : "HL7 International / Patient Care",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"actor" : [
{
"actorId" : "mainClinic",
"type" : "entity",
"name" : "Main Street Clinic",
"description" : "Dr. Blackrock's EHR - creates referral at patient's request"
},
{
"actorId" : "YMCA",
"type" : "entity",
"name" : "Cincinnati Central YMCA",
"description" : "Fitness service provider who offers exercise program"
}
],
"instance" : [
{
"resourceId" : "Scen3query1",
"resourceType" : "Binary",
"name" : "Query for Referral & Patient for YMCA Task",
"description" : "Search to retrieve ServiceRequest and Patient for specified Task: `GET https://mainClinic.example.org/fhir/ServiceRequest?_id=Scen3ServiceRequest&_include=ServiceRequest:patient`"
},
{
"resourceId" : "Scen3query2",
"resourceType" : "Binary",
"name" : "Query for EHR-issued task based on notification",
"description" : "Search to retrieve Task: `GET https://YMCA.example.org/fhir/Task?_id=Scen3TaskYMCA`"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference" : {
"reference" : "Subscription/Scen3SubscriptionEhr"
}
}
],
"resourceId" : "Scen3SubscriptionEhr",
"resourceType" : "Subscription",
"name" : "Subscription from EHR",
"description" : "Establishes the subscription for the EHR to monitor tasks it's created"
},
{
"resourceId" : "Scen3TaskYMCA",
"resourceType" : "Task",
"name" : "Task seeking FitLife to fulfill referral",
"description" : "A Task seeking fulfillment by the YMCA of the referral for an exercise program",
"version" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "Initial YMCA Task"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
"reference" : "Task/Scen3TaskYMCAV1"
}
}
],
"versionId" : "1",
"description" : "Initial version of the referral fulfillment request for YMCA with a status of 'requested'"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "Updated YMCA Task"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
"reference" : "Task/Scen3TaskYMCAV2"
}
}
],
"versionId" : "2",
"description" : "Version of the referral fulfillment request for YMCA after it has been changed to 'accepted'"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "Completed YMCA Task"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
"reference" : "Task/Scen3TaskYMCAV3"
}
}
],
"versionId" : "3",
"description" : "Version of the referral fulfillment request for YMCA after it has been changed to 'completed' and a link to the report added"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference" : {
"reference" : "Bundle/Scen3ServiceRequestYMCAResponseBundle"
}
}
],
"resourceId" : "Scen3ServiceRequestYMCAResponseBundle",
"resourceType" : "Bundle",
"name" : "ServiceRequest search response for YMCA",
"description" : "Search-set Bundle returning ServiceRequest and Patient for the Task posted to the YMCA"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference" : {
"reference" : "Bundle/Scen3NotificationUpdatedTaskBundle"
}
}
],
"resourceId" : "Scen3NotificationUpdatedTaskBundle",
"resourceType" : "Bundle",
"name" : "Subscription Notification that Task has updated",
"description" : "Pointer to the Task that has been updated"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference" : {
"reference" : "Bundle/Scen3NotificationCompletedTaskBundle"
}
}
],
"resourceId" : "Scen3NotificationCompletedTaskBundle",
"resourceType" : "Bundle",
"name" : "Subscription Notification that Task has completed",
"description" : "Pointer to the Task that has been updated"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference" : {
"reference" : "Bundle/Scen3TaskEHRResponseBundle1"
}
}
],
"resourceId" : "Scen3TaskEHRResponseBundle1",
"resourceType" : "Bundle",
"name" : "Accepted Task search response for EHR",
"description" : "Search-set Bundle returning 'accepted' Task with id based on subscription notification",
"containedInstance" : [
{
"resourceId" : "Scen3TaskYMCA",
"versionId" : "2"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference" : {
"reference" : "Bundle/Scen3TaskEHRResponseBundle2"
}
}
],
"resourceId" : "Scen3TaskEHRResponseBundle2",
"resourceType" : "Bundle",
"name" : "Completed Task search response for EHR",
"description" : "Search-set Bundle returning 'completed' Task with id based on subscription notification",
"containedInstance" : [
{
"resourceId" : "Scen3TaskYMCA",
"versionId" : "3"
}
]
}
],
"process" : [
{
"title" : "Subscription Establishment",
"preConditions" : "Main Street Clinic and Cinicinnati Central YMCA have established legal and technical arrangements for interoperability",
"postConditions" : "Subscription is successfully created allowing Main Street Clinic to monitor YMCA-assigned Tasks",
"step" : [
{
"operation" : {
"number" : "1",
"type" : "create",
"name" : "Create EHR-monitoring Subscription",
"initiator" : "YMCA",
"receiver" : "mainClinic",
"description" : "YMCA posts Subscription to EHR to monitor Tasks. Request: `POST https://mainClinic.example.org/fhir/Subscription` Response: `201 Created`",
"request" : {
"resourceId" : "Scen3SubscriptionEhr"
}
}
}
]
},
{
"title" : "A minute after creation of ServiceRequest",
"preConditions" : "EHR has created a ServiceRequest for Mr. Shevchenko",
"postConditions" : "YMCA has retrieved the ServiceRequest and the Patient, and updated the Task to 'in-progress'",
"step" : [
{
"operation" : {
"number" : "2",
"type" : "create",
"name" : "Create Task on YMCA",
"initiator" : "mainClinic",
"receiver" : "YMCA",
"description" : "New Task is created directly on YMCA's server. Request: `POST https://YMCA.example.org/fhir/Task` Response: `201 Created`",
"request" : {
"resourceId" : "Scen3TaskYMCA",
"versionId" : "1"
}
}
},
{
"operation" : {
"number" : "3",
"type" : "search-type",
"name" : "YMCA retrieves referral",
"initiator" : "YMCA",
"receiver" : "mainClinic",
"description" : "YMCA retrieves the ServiceRequest and Patient referenced by the Task.",
"request" : {
"resourceId" : "Scen3query1"
},
"response" : {
"resourceId" : "Scen3ServiceRequestYMCAResponseBundle"
}
}
},
{
"operation" : {
"number" : "4",
"type" : "create",
"name" : "EHR gets referral acceptance",
"initiator" : "YMCA",
"receiver" : "mainClinic",
"description" : "A subscription notification to the EHR is triggered when YMCA changes the prescription status to 'in-progress'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`",
"request" : {
"resourceId" : "Scen3NotificationUpdatedTaskBundle"
}
}
},
{
"operation" : {
"number" : "5",
"type" : "search-type",
"name" : "EHR retrieves in-progress Task",
"initiator" : "mainClinic",
"receiver" : "YMCA",
"description" : "EHR retrieves the Task referenced by the subscription notification",
"request" : {
"resourceId" : "Scen3query2"
},
"response" : {
"resourceId" : "Scen3TaskEHRResponseBundle1"
}
}
}
]
},
{
"title" : "About 4 Months Later",
"preConditions" : "YMCA is actively working on the Task",
"postConditions" : "YMCA has completed the referral and Dr. Blackrock is aware of the results",
"step" : [
{
"operation" : {
"number" : "6",
"type" : "create",
"name" : "EHR gets referral acceptance",
"initiator" : "YMCA",
"receiver" : "mainClinic",
"description" : "A subscription notification to the EHR is triggered when the YMCA changes the Task status to 'completed'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`",
"request" : {
"resourceId" : "Scen3NotificationCompletedTaskBundle"
}
}
},
{
"operation" : {
"number" : "7",
"type" : "search-type",
"name" : "EHR retrieves completed Task",
"initiator" : "mainClinic",
"receiver" : "YMCA",
"description" : "EHR retrieves the Task referenced by the subscription notification",
"request" : {
"resourceId" : "Scen3query2"
},
"response" : {
"resourceId" : "Scen3TaskEHRResponseBundle2"
}
}
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.